Configuration

Code Scrawl is configured through json.

Docs

• Config File Locations
• Default Configs (with extensive comments)
• Alternate Setup

Config File Locations

Configs can be created at any of these locations:

• config/scrawl.json
• .config/scrawl.json
• .docsrc/scrawl.json
• scrawl.json (root of your project)

Default Configs

@file(src/defaults-comments.json)

Note: Config keys have been updated June 9, 2025. All old config names will continue to work.

Alternate Setup

You can create your own bin script to execute Code Scrawl.

Example:

#!/usr/bin/env php
<?php
$scrawl = new \Tlf\Scrawl(array $options);
$scrawl->file_bootstrap = 'scrawl-bootstrap.php'; // you can also set properties directly
$scrawl->run();

Then you can execute it with bin/my-scrawl-script (if the file is executable) or php bin/my-scrawl-script

For more information, look at the properties and constructor in @see(src/Scrawl.php, Scrawl.php)

Note: The keys are different when passing options this way than when using the built-in method to run Scrawl.